Improve project documentation #57
Merged
+212
−234
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace the default frontend README with project-specific setup instructions. Add backend README covering setup, GraphQL API, and development commands. Update root README with current project status, dataset rationale, architecture, and technology stack. Clarify the use of MariaDB instead of MySQL in the architecture documentation. Clarify current testing status and planned automated testing.
Closed
Sign in
to join this conversation on GitHub.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Improve the project documentation to make it easier for developers to understand the application, set up the development environment, and work with the codebase.
Changes:
Issue
Closes: #47